/*
 * Copyright 2022 Bytedance Inc.
 *
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.bytedance.primus.io.datasource.file.models;

import com.bytedance.primus.apiserver.proto.DataProto.FileSourceSpec;

/**
 * Primus schedules data into batches to interleave them among different data sources, so that the
 * model won't be overly optimized for a single data source while training. BaseInput represents a
 * batch of data from a DataSource, which is used to populate BaseSplits for actual data injection.
 */
public interface BaseInput {

  String getBatchKey(); // The key for the batch

  int getSourceId(); // The UniqID of the data source.

  FileSourceSpec getSpec(); // The specification of the data source
}
